org.eclipse.vtp.framework.interactions.core.configurations
Class MetaDataItemConfiguration

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.configurations.MetaDataItemConfiguration

All Implemented Interfaces:

IConfiguration, InteractionsConstants

public class MetaDataItemConfiguration
extends java.lang.Object
implements IConfiguration, InteractionsConstants

A single meta-data item configuration.

Author:

Lonnie Pryor

Field Summary

static int	TYPE_EXPRESSION A variable value derived from an expression.
static int	TYPE_STATIC A static variable value.
static int	TYPE_VARIABLE A variable value derived from another variable.

Fields inherited from interface org.eclipse.vtp.framework.interactions.core.configurations.InteractionsConstants

NAME_CHOICE, NAME_CHOICES, NAME_CONTENT_TYPE, NAME_DATA_NAME, NAME_DATA_REQUEST, NAME_FORMATTER, NAME_ID, NAME_INPUT, NAME_INPUT_ITEM, NAME_INPUT_NAME, NAME_INPUT_REQUEST, NAME_INTERACTION_TYPE, NAME_KEY, NAME_LANGUAGE, NAME_LOCALE, NAME_MEDIA, NAME_MEDIA_PROVIDER, NAME_MEDIA_PROVIDER_BINDING, NAME_META_DATA, NAME_META_DATA_ITEM, NAME_META_DATA_SET, NAME_NAME, NAME_OUTPUT, NAME_OUTPUT_ITEM, NAME_OUTPUT_MESSAGE, NAME_OUTPUT_NAME, NAME_PROPERTY, NAME_PROPERTY_ITEM, NAME_RESOURCE_MANAGER, NAME_SCRIPT, NAME_SCRIPTING_LANGUGAGE, NAME_SELECTION_REQUEST, NAME_SHARED_CONTENT, NAME_TRANSFER_MESSAGE, NAME_TYPE, NAME_VALUE, NAMESPACE_URI

Constructor Summary

MetaDataItemConfiguration()
Creates a new MetaDataItemConfiguration.

Method Summary

java.lang.String	getName() Returns the name of the target variable.
java.lang.String	getScriptingLanguage() Returns the scripting language the expression is in.
java.lang.String	getValue() Returns the variable value.
int	getValueType() Returns the type of the variable value.
void	load(org.w3c.dom.Element configurationElement) Loads the configuration information from the specified XML element.
void	save(org.w3c.dom.Element configurationElement) Saves the configuration information into the supplied XML element.
void	setExpressionValue(java.lang.String expression, java.lang.String scriptingLanguage) Sets the value of the target variable as the result of an expression.
void	setName(java.lang.String name) Sets the name of the target variable.
void	setStaticValue(java.lang.String value) Sets the value of the target variable as a static value.
void	setVariableValue(java.lang.String variableName) Sets the value of the target variable as an existing variable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_STATIC

public static final int TYPE_STATIC

A static variable value.

See Also:

Constant Field Values

TYPE_EXPRESSION

public static final int TYPE_EXPRESSION

A variable value derived from an expression.

See Also:

Constant Field Values

TYPE_VARIABLE

public static final int TYPE_VARIABLE

A variable value derived from another variable.

See Also:

Constant Field Values

Constructor Detail

MetaDataItemConfiguration

public MetaDataItemConfiguration()

Creates a new MetaDataItemConfiguration.

Method Detail

getName

public java.lang.String getName()

Returns the name of the target variable.

Returns:

The name of the target variable.

setName

public void setName(java.lang.String name)

Sets the name of the target variable.

Parameters:

name - The name of the target variable.

getValueType

public int getValueType()

Returns the type of the variable value.

Returns:

The type of the variable value.

getValue

public java.lang.String getValue()

Returns the variable value.

Returns:

The variable value.

getScriptingLanguage

public java.lang.String getScriptingLanguage()

Returns the scripting language the expression is in.

Returns:

The scripting language the expression is in.

setStaticValue

public void setStaticValue(java.lang.String value)

Sets the value of the target variable as a static value.

Parameters:

value - The value of the target variable.

setExpressionValue

public void setExpressionValue(java.lang.String expression,
                               java.lang.String scriptingLanguage)

Sets the value of the target variable as the result of an expression.

Parameters:

expression - The expression to evaluate.

scriptingLanguage - The scripting language the expression is in.

setVariableValue

public void setVariableValue(java.lang.String variableName)

Sets the value of the target variable as an existing variable.

Parameters:

variableName - The name of the variable to set as the target variable.

load

public void load(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Loads the configuration information from the specified XML element.

Specified by:

load in interface IConfiguration

Parameters:

configurationElement - The element to load the configuration from.

save

public void save(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Saves the configuration information into the supplied XML element.

Specified by:

save in interface IConfiguration

Parameters:

configurationElement - The element to save the configuration to.